home *** CD-ROM | disk | FTP | other *** search
/ User's Choice Windows CD / User's Choice Windows CD (CMS Software)(1993).iso / windows4 / profile.zip / README < prev    next >
Text File  |  1991-05-08  |  4KB  |  111 lines
  1.  
  2.                   Microsoft Usage and Description README File
  3.  
  4.                           Windows 16-bit API Profiler
  5.                                October 30, 1990
  6.  
  7.  
  8.  
  9. 1. Hardware/Software Requirements
  10.  
  11.     o  80386 based PC
  12.     o  Windows 3.x
  13.  
  14.  
  15.  
  16. 2. Profiling DLLS
  17.  
  18.     o  zernel.*      kernel APIs' profiling DLL.
  19.     o  zser.*        user APIs' profiling DLL.
  20.     o  zdi.*         gdi APIs' profiling DLL.
  21.  
  22.  
  23.  
  24. 3. Other Files
  25.  
  26.     o  apfcnvrt.exe  Converts modules from the application to be profiled
  27.                          to use the profiling DLL(s).  
  28.                          (OS/2 bound type exe)
  29.  
  30.     o  apfdump.exe   Dumps profiling data while application is running.
  31.                          (Windows type exe)
  32.  
  33.     o  timerwin.dll  Timer DLL used for profiling under Windows.
  34.         
  35.         o  vtd.386       A Virtual Timer Device to be used under WIN 3.0
  36.                          (Windows 3.1 and above will have this virtual device
  37.                           built in)
  38.  
  39.  
  40.  
  41. 4. How to Run the Profiler
  42.  
  43.     o  Copy the profiling dlls to someplace on your lib path.  
  44.  
  45.         o  Copy the timer DLL (timerWIN.dll) to someplace on your lib path.  
  46.            If profiling under Windows 3.0, VTD.386 need to be installed
  47.            in SYSTEM.INI file.  Replace "device=*vtd" line with 
  48.            "device=%fullpath%\vtd386".  Windows 3.1 and above will have this
  49.            VTD built in.
  50.  
  51.         o  Use APFCNVRT to convert the modules from the application you
  52.            wish to profile to use profiling DLL(s).
  53.  
  54.            Examples:
  55.               apfcnvrt ?                      -- Displays the usage
  56.               apfcnvrt win excel.exe          -- Profiles all windows calls
  57.                                                  under excel
  58.               apfcnvrt zser winword.exe *.dll -- Profiles only user calls
  59.                                                  made by winword and its 
  60.                                                  supporting dll's.
  61.     
  62.         o  Run the application you wish to profile.
  63.  
  64.         o  You can run APFDUMP (windows app) to dump the profiling data while
  65.            the application is running.  As the default APFDUMP will dump the
  66.            profiling data to *.DMP files.  Dump files extenstion may be
  67.            changed from the dialog box.  If both <DUMP> and <CLEAR> options
  68.            are selected data will be cleared after data is dumped.
  69.  
  70.            Do *NOT* use 'DAT' as dump file extension in apfdump since once the
  71.            application is ended, the profiling info is dumped to *.DAT files.
  72.  
  73.         o  Use APFCNVRT to restore use of original mudules in the
  74.            profiled application. ("unhooking" the application from profiler)
  75.  
  76.            Examples:
  77.               apfcnvrt ?                      -- Displays the usage
  78.               apfcnvrt undo excel.exe         -- Restore original excel
  79.                                                  imports
  80.               apfcnvrt user winword.exe *.dll -- "unhooks" user profiling
  81.                                                  from winword and its 
  82.                                                  supporting dll's.
  83.  
  84.  
  85. 5. Profiling Data
  86.  
  87.         The following information is captured as profiling data:
  88.  
  89.         o  API name     -- API name
  90.         o  Num Calls    -- Number of times the API is called
  91.         o  Total Time   -- Total time for all the calls to the API
  92.         o  Time/call    -- Average time for API call
  93.         o  First Time   -- Time of first call to the API
  94.         o  Max Time     -- Maximum call time for the API (after the first call)
  95.         o  Min Time     -- Minimum call time for the API (after the first call)
  96.         o  Not Timed    -- Number of calls not timed due to timing overflows
  97.  
  98.  
  99.         All the fields in the dump files are tab separated so they
  100.         can be loaded under Excel.
  101.  
  102.  
  103.  
  104. 6. Comments
  105.  
  106.         o  The API profiling DLLs only work in enhanced mode.
  107.  
  108.  
  109.  
  110. *** END OF README ***
  111.